home *** CD-ROM | disk | FTP | other *** search
/ APDL Eductation Resources / APDL Eductation Resources.iso / programs / keyboard / keys / !Keys / !ReadMe < prev    next >
Encoding:
Text File  |  1990-02-20  |  6.0 KB  |  182 lines
  1. ->!ReadMe
  2.  
  3.                             Function Key Handler
  4.                             ====================
  5.  
  6. This disk contains a function key handler which allows the function keys to
  7. be defined and activated within the RISC OS environment.
  8.  
  9. The contents of this disc, are as follows;
  10.  
  11. !ReadMe       This file.
  12. !Boot         Keys !Boot file.
  13. !Run          Keys !Run file.
  14. !RunImage     Keys code.
  15. !RunMe        Display !ReadMe file.
  16. !Help         Help text file
  17. !Sprites      Directory of sprite files for the Keys application.
  18. Templates     Window templates.
  19. StdKeyDef     Default Key definitions called up by !Run file.
  20. Modules       Module directory containing :
  21.   Clib        The Shared C Library module from the RISC OS !System folder.
  22.  
  23. Memory Requirements
  24. ===================
  25.  
  26. Module Area   Sufficient for Clib
  27. Program Area  96K
  28.  
  29. Getting Started
  30. ===============
  31.  
  32. To copy this application onto another disc or install it on the hard disc
  33. open a directory viewer on the destination disc within the RISC OS Desktop
  34. and drag the !Keys icon to the destination directory.
  35.  
  36. The function key handler may be installed on the iconbar by double clicking
  37. on the !Keys application icon.
  38.  
  39. The function keys are then active.
  40.  
  41. The function keys may then be displayed just above the icon bar by selection
  42. of the Keys icon on the iconbar.
  43.  
  44. The keys application is controlled by the keys menu accessed by pressing the
  45. menu button while the mouse pointer is over the Keys iconbar icon.
  46.  
  47. The function of the menu options is as follows:
  48.  
  49.   Info provides current information about the application.
  50.  
  51.   Define opens a dialogue window allowing the operation of any of the 
  52.   function keys F1 to F12 to be defined.
  53.  
  54.   Show controls the display of the function keys just above the iconbar.
  55.   This allows the function key to be operated by selecting the displayed
  56.   key as well as pressing the keyboard key. A tick indicates the state of
  57.   the function keys display.
  58.  
  59.   Save allows the current key definitions to be saved to a file using the
  60.   standard 'Save as:' convention used by RISC OS applications.
  61.  
  62.   *Command opens a dialogue window allowing the entry of a * command.
  63.  
  64.   Quit removes the !Keys application from the Task memory.
  65.  
  66. Detailed Operation
  67. ==================
  68.  
  69. If a function key has been defined then it will always be operated on
  70. selection of the displayed key.
  71.  
  72. If a window has the input focus then keyboard functions keys may be handled
  73. directly by the corresponding application, e.g. Edit.  Function keys not
  74. recognised by the application should be passed on and subsequently processed
  75. by the function key handler.
  76.  
  77. If a function key is not defined the key code will be passed on to the wimp.
  78. In this case the function key may have a name, e.g. selecting F12, which has
  79. the name *, will allow the input of *commands below the iconbar.
  80.  
  81. Key Definition Files
  82. ====================
  83.  
  84. The definition of the function keys may be specified by creating a KeyDefs
  85. file, this has the following format.
  86.  
  87.   Each key definition appears on a separate line.
  88.  
  89.   The definition is introduced by the command 'key'
  90.  
  91.   The function key number appears in columns 5 and 6.
  92.  
  93.   The name assigned to the function key appears in columns 8 to 12 and may
  94.   be no more than 5 characters long. This name appears on the function key
  95.   displayed above the iconbar.
  96.  
  97.   The operation assigned to the function key is a string on no more than 75
  98.   characters starting in column 14.  
  99.  
  100. An example of this format can be seen in StdKeyDefs.
  101.  
  102. The definition of the function keys may also be specified by using the
  103. Define menu option and the saved to a KeyDefs file by using the Save menu
  104. option. This automatically produces the correct format for the KeyDefs file.
  105.  
  106. File Types
  107. ==========
  108.  
  109. As distibuted the !Boot file defines the file type for KeyDefs as 701 and
  110. sets up a run type alias for this file type.
  111.  
  112. The file type for KeyDefs may be set to any legal type the user requires.
  113. However a file type for KeyDefs must be set for correct operation of the
  114. !Keys application.
  115.  
  116. Limitations
  117. ===========
  118.  
  119. Only the Function Keys F1 to F12 can be defined.
  120.  
  121. Function Keys modified by the Control or Shift keys are not handled.
  122.  
  123. Operation with a multisync monitor has not been checked.
  124.  
  125.  
  126. *Command Entry
  127. ==============
  128.  
  129. *Commands may be entered using the *command dialogue box. If no window has
  130. the input focus, i.e. contains the caret, then the *command dialogue box
  131. will be displayed on entry of the first character of the required command.
  132. Otherwise the dialogue box can be opened using the *command entry in
  133. the Keys icon menu.
  134.  
  135. The dialogue box will accept a command string of up to 255 characters.
  136.  
  137. The dialogue box provides full editing features for the entered string, as
  138. follows:
  139.  
  140.   Delete      delete character to the left of caret.
  141.   Copy        delete character to the left of caret.
  142.   <-          move caret left one character.
  143.   ->          move caret right one character.
  144.   Shift Copy  delete word (forwards).
  145.   Shift <-    move left one word.
  146.   Shift ->    move right one word.
  147.   Ctrl Copy   delete to end of line (forwards).
  148.   Ctrl <-     move to left end of line.
  149.   Ctrl ->     move to right end of line.
  150.  
  151. The entered command can be aborted by selecting the CANCEL icon.
  152.  
  153. The *command is actioned by selecting the OK icon or pressing the <CR> key.
  154. Any output text is displayed within a mode 4 window.
  155.  
  156. ======
  157.  
  158. Release 1.01 February 1990
  159.  
  160. (c) Copyright Peter Tuson 1990
  161.  
  162. ======
  163.  
  164. If you find this program useful or interesting a donation of £2 sterling,
  165. sent to the address below, would be much appreciated. This will give me some
  166. incentive to distribute future programs that I may write.
  167.  
  168. This program will be upgraded in the future, improvements may include;
  169. command output to scrollable transcript window, support for shift and control
  170. for function keys, and a history mechanism for *command entry. 
  171.  
  172. If you have any comments, suggestions, bug reports or complaints, please
  173. write to the following address. This does not constitute a commitment
  174. to correct reported bugs.
  175.  
  176. Dr. P.R.Tuson
  177. 70, Connaught Road
  178. Fleet
  179. Hants.
  180. GU13 9QY
  181. United Kingdom.
  182.